SetMovieActive
TheSetMovieActive
function allows your application to activate and deactivate a movie.
pascal void SetMovieActive (Movie theMovie, Boolean active);
theMovie
- Specifies the movie for this operation. Your application obtains this movie identifier from such functions as
NewMovie
,NewMovieFromFile
, andNewMovieFromHandle
(described on page 2-80, page 2-76, and page 2-78, respectively).active
- Activates or deactivates the movie. Set this parameter to
true
to activate the movie; set this parameter tofalse
to deactivate the movie.SPECIAL CONSIDERATIONS
The Movie Toolbox services only active movies. When you deactivate a movie, the Movie Toolbox may release system resources required by the movie, such as sound hardware, open files, and allocated memory. Unless you set thenewMovieActive
flag when creating a movie, you should callSetMovieActive
before playing a movie.ERROR CODES
invalidMovie -2010 This movie is corrupted or invalid SEE ALSO
You can determine whether a movie is active by calling theGetMovieActive
function, which is described in the next section.